Skip to main content
POST
/
v1
/
organizations
/
{organization_id}
/
projects
/
{project_id}
/
compute
/
instances
/
{id}
/
monitors
/
{monitor_id}
/
check
[Monitors] Run monitor check
curl --request POST \
  --url https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}/monitors/{monitor_id}/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "size_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "os_name": "<string>",
  "hostname": "<string>",
  "vpc_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billing_cycle": "free",
  "tags": "<unknown>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "monitor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "up",
  "checked_at": "2023-11-07T05:31:56Z",
  "latency_ms": "<string>",
  "response_code": "<string>",
  "error_message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://help.onetsolutions.net/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this Instance.

​
monitor_id
string
required

Unique identifier of the monitor.

​
organization_id
string<uuid>
required
​
project_id
string<uuid>
required

Body

application/json
​
name
string
required

Instance name

Maximum string length: 255
​
size_id
string<uuid>
required
write-only
​
location_id
string<uuid>
required
write-only
​
image_id
string<uuid>
required
write-only
​
os_name
string
required

Operating system name

Maximum string length: 100
​
hostname
string

Instance hostname

Maximum string length: 255
​
vpc_id
string<uuid> | null
write-only
​
billing_cycle
enum<string>
  • free - Free
  • one_time - One Time
  • hourly - Hourly
  • monthly - Monthly
  • quarterly - Quarterly
  • semi_annually - Semi-Annually
  • annually - Annually
  • biennially - Biennially
  • triennially - Triennially
Available options:
free,
one_time,
hourly,
monthly,
quarterly,
semi_annually,
annually,
biennially,
triennially
​
tags
any

Custom tags

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
monitor
string<uuid>
required
​
status
enum<string>
required
  • up - Up
  • down - Down
  • degraded - Degraded
  • pending - Pending
Available options:
up,
down,
degraded,
pending
​
checked_at
string<date-time>
required
read-only
​
latency_ms
string | null
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
​
response_code
string
Maximum string length: 50
​
error_message
string